home *** CD-ROM | disk | FTP | other *** search
/ Aminet 24 / Aminet 24 (1998)(GTI - Schatztruhe)[!][Apr 1998].iso / Aminet / comm / misc / CapiRexxVoiceM.lha / capi-usr.doc < prev    next >
Encoding:
Text File  |  1996-10-09  |  8.1 KB  |  285 lines
  1. TABLE OF CONTENTS
  2.  
  3. U_CAPI_REGISTER
  4. U_CAPI_RELEASE
  5. U_CAPI_PUT_MESSAGE
  6. U_CAPI_GET_MESSAGE
  7. U_CAPI_SET_SIGNAL
  8. U_CAPI_GET_MANUFACTURER
  9. U_CAPI_GET_VERSION
  10. U_CAPI_GET_SERIAL_NUMBER
  11. U_CAPI_GET_PROFILE
  12. U_CAPI_INSTALLED
  13. U_CAPI_REGISTER                                         U_CAPI_REGISTER
  14.  
  15.    NAME
  16.    U_CAPI_REGISTER -- Register an application with the CAPI
  17.  
  18.    SYNOPSIS
  19.    result = U_CAPI_REGISTER( maxLogicalConnection, maxBDataBlocks,
  20.                              maxBDataLen, pApplId );
  21.  
  22.    unsigned U_CAPI_REGISTER( unsigned, unsigned,
  23.                              unsigned, unsigned short * );
  24.  
  25.    FUNCTION
  26.    This is the operation the application uses to report its presence
  27.    to the CAPI. By passing the four first parameters, the application
  28.    describes its needs.
  29.  
  30.    INPUTS
  31.    maxLogicalConnection - Maximum number of logical connections
  32.    maxBDataBlocks       - Number of data blocks available simultaneously
  33.    maxBDataLen          - Maximum size of a data block
  34.    pApplId              - Pointer to the location where CAPI should place
  35.                           the ID of the newly registered application.
  36.                           A valid ID will never be zero.
  37.  
  38.    RESULT
  39.    0 if successful, or parameter info class 0x10xx
  40.  
  41.    SEE ALSO
  42.    U_CAPI_RELEASE()
  43.  
  44. U_CAPI_RELEASE                                           U_CAPI_RELEASE
  45.  
  46.    NAME
  47.    U_CAPI_RELEASE -- Terminate access to the CAPI
  48.  
  49.    SYNOPSIS
  50.    result = U_CAPI_RELEASE( applId );
  51.  
  52.    unsigned U_CAPI_RELEASE( unsigned short );
  53.  
  54.    FUNCTION
  55.    The application uses this operation to log off from CAPI.
  56.    CAPI will release all resources that have been allocated.
  57.  
  58.    INPUTS
  59.    applId - Application ID as received from CAPI_REGISTER(),
  60.             or zero for no action.
  61.  
  62.    RESULT
  63.    0 if successful, or parameter info class 0x11xx
  64.  
  65.    SEE ALSO
  66.    U_CAPI_REGISTER()
  67.  
  68. U_CAPI_PUT_MESSAGE                                   U_CAPI_PUT_MESSAGE
  69.  
  70.    NAME
  71.    U_CAPI_PUT_MESSAGE -- Send a message from the application to the CAPI
  72.  
  73.    SYNOPSIS
  74.    result = U_CAPI_PUT_MESSAGE( applId, pCAPIMessage );
  75.  
  76.    unsigned U_CAPI_PUT_MESSAGE( unsigned short, CAPI_MESSAGE * );
  77.  
  78.    FUNCTION
  79.    With this operation the application transfers a message to the CAPI.
  80.    Under OS/2, the message memory area must not cross a 64 kByte
  81.    boundary in the flat address space because the DLL may convert the
  82.    passed flat pointer to a 16:16 bit segmented pointer.
  83.  
  84.    INPUTS
  85.    applId       - Application ID as received from U_CAPI_REGISTER()
  86.    pCAPIMessage - Pointer to the message
  87.  
  88.    RESULT
  89.    0 if successful, or parameter info class 0x11xx
  90.  
  91.    SEE ALSO
  92.    U_CAPI_GET_MESSAGE()
  93.  
  94. U_CAPI_GET_MESSAGE                                   U_CAPI_GET_MESSAGE
  95.  
  96.    NAME
  97.    U_CAPI_GET_MESSAGE -- Get a message from the CAPI
  98.  
  99.    SYNOPSIS
  100.    result = U_CAPI_GET_MESSAGE( applId, ppCAPIMessage );
  101.  
  102.    unsigned U_CAPI_GET_MESSAGE( unsigned short, CAPI_MESSAGE ** );
  103.  
  104.    FUNCTION
  105.    With this operation the application retrieves a message from the CAPI.
  106.    The application can only retrieve those messages intended for the
  107.    stipulated application identification number. If there is no message
  108.    waiting for retrieval, the function returns immediately with an
  109.    error code.
  110.  
  111.    INPUTS
  112.    applId        - Application ID as received from U_CAPI_REGISTER()
  113.    ppCAPIMessage - Pointer to the memory location where CAPI should
  114.                    place a pointer to the data of the retrieved message
  115.  
  116.    RESULT
  117.    0 if successful, or parameter info class 0x11xx
  118.  
  119.    SEE ALSO
  120.    U_CAPI_PUT_MESSAGE()
  121.  
  122. U_CAPI_SET_SIGNAL                                     U_CAPI_SET_SIGNAL
  123.  
  124.    NAME
  125.    U_CAPI_SET_SIGNAL -- Install a signalling mechanism
  126.  
  127.    SYNOPSIS
  128.    success = U_CAPI_SET_SIGNAL( applId, callback, para );
  129.  
  130.    unsigned short U_CAPI_SET_SIGNAL( unsigned short, unsigned long,
  131.                                      unsigned long );
  132.  
  133.    FUNCTION
  134.    This operation is used by the application to install a mechanism
  135.    which signals the application the availability of a message.
  136.  
  137.    In that case each time CAPI places a message in the application's
  138.    message queue, the specified callback function is called.
  139.  
  140.    By issuing this function call with a callback value of 0 the
  141.    signalling mechanism is deactivated.
  142.  
  143.    The called function must have the following format:
  144.    void callback( unsigned short applID, unsigned long para );
  145.  
  146.    INPUTS
  147.    applId   - ID of Application posting the request
  148.    callback - Pointer to the function to be called
  149.    para     - Parameter passed to callback function (application's use)
  150.  
  151.    RESULT
  152.    success - 0 if OK, or parameter info class 11 upon failure.
  153.  
  154.    SEE ALSO
  155.  
  156. U_CAPI_GET_MANUFACTURER                         U_CAPI_GET_MANUFACTURER
  157.  
  158.    NAME
  159.    U_CAPI_GET_MANUFACTURER -- Get manufacturer ID of the CAPI driver
  160.  
  161.    SYNOPSIS
  162.    U_CAPI_GET_MANUFACTURER( SzBuffer );
  163.  
  164.    void U_CAPI_GET_MANUFACTURER( char * );
  165.  
  166.    FUNCTION
  167.    With this operatrion the application determines the manufacturer
  168.    identification of the installed CAPI driver. SzBuffer on call is
  169.    a pointer to a buffer of 64 bytes. CAPI copies the identification
  170.    string, coded as a zero-terminated ASCII string, to this buffer.
  171.  
  172.    INPUTS
  173.    SzBuffer - Pointer to a buffer of 64 bytes
  174.  
  175.    RESULT
  176.    none
  177.  
  178.    SEE ALSO
  179.    U_CAPI_GET_VERSION(), U_CAPI_GET_SERIAL_NUMBER()
  180.  
  181. U_CAPI_GET_VERSION                                   U_CAPI_GET_VERSION
  182.  
  183.    NAME
  184.    U_CAPI_GET_VERSION -- Get CAPI version numbers
  185.  
  186.    SYNOPSIS
  187.    result = U_CAPI_GET_VERSION( pVersionNumbers )
  188.  
  189.    void U_CAPI_GET_VERSION( unsigned long * );
  190.  
  191.    FUNCTION
  192.    With this function the appplication determines the version of the
  193.    CAPI as well as an internal version number.
  194.  
  195.    INPUTS
  196.    pVersionNumbers - Pointer to an array of four U32s receiving
  197.                      the following four version numbers:
  198.  
  199.                      1st: CAPI major version number (currently 2)
  200.                      2nd: CAPI minor version number (currently 0)
  201.                      3rd: Manufacturer specific major version number
  202.                      4th: Manufacturer specific minor version number
  203.  
  204.    RESULT
  205.    none
  206.  
  207.    SEE ALSO
  208.    U_CAPI_GET_MANUFACTURER(), U_CAPI_GET_SERIAL_NUMBER()
  209.  
  210. U_CAPI_GET_SERIAL_NUMBER                       U_CAPI_GET_SERIAL_NUMBER
  211.  
  212.    NAME
  213.    U_CAPI_GET_SERIAL_NUMBER -- Get the serial number of the CAPI
  214.  
  215.    SYNOPSIS
  216.    result = U_CAPI_GET_SERIAL_NUMBER( SzBuffer );
  217.  
  218.    void U_CAPI_GET_SERIAL_NUMBER( char * );
  219.  
  220.    FUNCTION
  221.    With this operation the application determines the (optional) serial
  222.    number of the CAPI. SzBuffer on call is a pointer to a buffer of 8
  223.    bytes. CAPI copies the serial number string to this buffer. The serial
  224.    number, coded as a zero terminated ASCII string, represents a seven
  225.    digit number after the function has returned.
  226.  
  227.    INPUTS
  228.    SzBuffer - Pointer to a buffer of 8 bytes
  229.  
  230.    RESULT
  231.    none
  232.  
  233.    SEE ALSO
  234.    U_CAPI_GET_VERSION(), U_CAPI_GET_MANUFACTURER()
  235.  
  236. U_CAPI_GET_PROFILE                                   U_CAPI_GET_PROFILE
  237.  
  238.    NAME
  239.    U_CAPI_GET_PROFILE -- Get the profile of a controller
  240.  
  241.    SYNOPSIS
  242.    result = U_CAPI_GET_PROFILE( SzBuffer, CtrlNr );
  243.  
  244.    unsigned U_CAPI_GET_PROFILE( CAPI_PROFILE *, unsigned short );
  245.  
  246.    FUNCTION
  247.    The application uses this function to get the capabilities from CAPI.
  248.    SzBuffer on call is a pointer to a buffer of 64 bytes. In this buffer
  249.    CAPI copies information about implemented features, number of
  250.    controllers and supported protocols. CtrlNr contains the controller
  251.    number (bit 0..6) for which this information is requested.
  252.  
  253.    INPUTS
  254.    SzBuffer - Pointer to a buffer receiving the CAPI_PROFILE structure.
  255.    CtrlNr   - Number of controller. If 0, only the number of installed
  256.               controllers is given to the application.
  257.  
  258.    RESULT
  259.    0 if successful, or parameter info class 0x11xx
  260.  
  261.    SEE ALSO
  262.  
  263. U_CAPI_INSTALLED                                       U_CAPI_INSTALLED
  264.  
  265.    NAME
  266.    U_CAPI_INSTALLED -- Find out if a CAPI driver is installed
  267.  
  268.    SYNOPSIS
  269.    result = U_CAPI_INSTALLED();
  270.  
  271.    unsigned U_CAPI_INSTALLED( void );
  272.  
  273.    FUNCTION
  274.    The application can use this function to find out if the CAPI
  275.    driver is installed.
  276.  
  277.    INPUTS
  278.    none
  279.  
  280.    RESULT
  281.    0 if capi is installed, non-zero otherwise.
  282.  
  283.    SEE ALSO
  284.  
  285.